# Client Matter
Creates or updates the full client/matter structure (site collection, site, document libraries, permissions, folders, and matter list entry). This is the primary handler for full matter provisioning. Accepts either an Excel file (one row per matter) or a JSON file (single matter).
Filename pattern:
- Excel: filename must contain
clientmatter(case-insensitive).
Example:20240115 clientmatter new.xlsx - JSON: filename must contain
clientmatterwith a.jsonextension.
Example:ClientMatter_32211_10332.json
# Excel format
# Client columns
| Name | Required | Description |
|---|---|---|
| ClientID | No | External system ID for the client. |
| ClientCode | Yes | Client identifier. |
| ClientName | No | Client display name. |
| ClientSiteCollectionSet | No | Name of the SiteCollectionCfg template to use for the client site collection. |
| ClientSiteSet | No | Name of the SiteCfg template to apply to the client site. |
| ClientPermissionSet | No | Name of the PermissionSetCfg to apply to the client. |
Client.<field> | No | Columns prefixed with Client. are passed as client properties (e.g. Client.Country). |
# Matter columns
| Name | Required | Description |
|---|---|---|
| MatterID | No | External system ID for the matter. |
| MatterCode | No | Matter identifier. |
| MatterName | No | Matter display name. |
| MatterSiteCollectionSet | No | Name of the SiteCollectionCfg template for the matter site collection. |
| MatterOffice365GroupSet | No | Name of the Office365GroupCfg template for an M365 group/team. |
| MatterSiteSet | No | Name of the SiteCfg template to apply to the matter site. |
| MatterPermissionSet | No | Name of the PermissionSetCfg to apply to the matter. |
| MatterListItemPermissionSet | No | Name of the PermissionSetCfg to apply to the matter list item. |
| MatterDocLibSets / MatterDocLibSet / DocLibSet | No | Semicolon-separated names of DocLibCfg templates to provision. |
| MatterDocLibPermissionSets / MatterDocLibPermissionSet | No | Semicolon-separated PermissionSetCfg names for each document library. |
| MatterDocLibFolderSets / FolderSets / FolderSet / DocLibFolderSets / DocLibFolderSet | No | Semicolon-separated FolderCfg names for folder creation in document libraries. |
| MatterPageSet | No | Name of the PageCfg template to apply. |
| MyMattersList | No | Semicolon-separated list of users to add to the My Matters list. |
| ClientMatterStructure / ClientMatterDesign | No | Override the matter provisioning structure (e.g. ClientSiteCollection_MatterDocLib). |
| ServerRelativeUrl | No | Override the server-relative URL for site creation. |
Matter.<field> | No | Columns prefixed with Matter. are passed as matter properties (e.g. Matter.MatterType). Columns without a prefix are also added as matter properties. |
# JSON format
A JSON file containing a single object. Fields mirror the Excel columns but use JSON types — arrays instead of semicolon-separated strings, and nested objects for client/matter properties.
| Field | Required | Description |
|---|---|---|
| ClientCode | Yes | Client identifier. |
| ClientID | No | External system ID for the client. |
| ClientName | No | Client display name. |
| ClientSiteCollectionSet | No | Name of the SiteCollectionCfg template for the client site collection. |
| ClientSiteSet | No | Name of the SiteCfg template for the client site. |
| ClientPermissionSet | No | Name of the PermissionSetCfg for the client. |
| ClientProperties | No | Object of arbitrary key/value pairs passed as client metadata. |
| MatterCode | No | Matter identifier. |
| MatterID | No | External system ID for the matter. |
| MatterName | No | Matter display name. |
| MatterSiteCollectionSet | No | Name of the SiteCollectionCfg template for the matter site collection. |
| MatterOffice365GroupSet | No | Name of the Office365GroupCfg template for an M365 group/team. |
| MatterSiteSet | No | Name of the SiteCfg template for the matter site. |
| MatterPermissionSet | No | Name of the PermissionSetCfg for the matter. |
| MatterListItemPermissionSet | No | Name of the PermissionSetCfg for the matter list item. |
| MatterDocLibSets | No | Array of DocLibCfg template names to provision. |
| MatterDocLibPermissionSets | No | Array of PermissionSetCfg names, one per document library. |
| MatterDocLibFolderSets | No | Array of FolderCfg names for folder creation in document libraries. |
| MatterPageSet | No | Name of the PageCfg template to apply. |
| MyMattersList | No | Array of users to add to the My Matters list. |
| ClientMatterStructure | No | Override the provisioning structure (e.g. ClientSiteCollection_MatterDocLib). |
| ServerRelativeUrl | No | Override the server-relative URL for site creation (e.g. sites). |
| MatterProperties | No | Object of arbitrary key/value pairs passed as matter metadata. |
Example:
{
"ClientCode": "32211",
"ClientName": "Qwerty",
"ClientSiteCollectionSet": "ClientSiteCollection",
"ClientSiteSet": "ClientSite",
"ClientPermissionSet": "ClientPermissionSet",
"ClientProperties": { "Country": "NL" },
"MatterCode": "10332",
"MatterName": "Qwerty / Azerty",
"MatterSiteCollectionSet": "MatterSiteCollection",
"MatterSiteSet": "MatterSite",
"MatterPermissionSet": "ClientPermissionSet",
"MatterDocLibSets": ["MatterDoclib", "MatterDoclibAdvice"],
"MatterDocLibPermissionSets": ["MatterDoclibContribute", "MatterDoclibRead"],
"MatterProperties": { "MatterType": "Tax", "AreaOfLaw": "Advice" },
"ClientMatterStructure": "ClientSiteCollection_MatterDocLib",
"ServerRelativeUrl": "sites"
}
# Behavior
The handler delegates to an IClientMatterInformationHandler implementation, which orchestrates the full provisioning sequence: site collection creation, site configuration, document library setup, permission assignment, folder creation, and matter list registration. The exact steps depend on which template names and columns are provided.
# Related links
- Matter List handler — create or update matter list entries only
- Client List handler — create or update client list entries only
- Site Collection handler — create site collections independently